home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 3 / BBS in a box - Trilogy III.iso / Files / System7 tools / S / S7P Demo ƒ / Frontier™ ƒ / FourthDimension.DocServer next >
Encoding:
Text File  |  1992-04-07  |  4.4 KB  |  108 lines  |  [TEXT/ttxt]
  1.  
  2. Verb    FourthDimension.countFiles
  3. Syntax    FourthDimension.countFiles()
  4. Parameters    None.
  5. Action    Returns the number of files in your database.
  6. Returns    an integer value, the number of files in your 4D database.
  7. Examples    FourthDimension.countFiles()
  8.     » 1
  9.  
  10. Verb    FourthDimension.countFields
  11. Syntax    FourthDimension.countFields(fileno)
  12. Parameters    fileno is the number of the file in your 4D database.
  13. Action    Returns the number of fields in the specified file.
  14. Returns    an integer value, the number of fields in the specified file
  15. Examples    FourthDimension.countFields(1)
  16.     » 5
  17.  
  18. Verb    FourthDimension.fileName
  19. Syntax    FourthDimension.fileName(fileno)
  20. Action    Returns the name of the specified file.
  21. Parameters    fileno is the number of the file in your database.
  22. Returns    a string, the name of the specified file
  23. Examples    FourthDimension.fileName(1)
  24.     » Names
  25.  
  26. Verb    FourthDimension.fieldName
  27. Syntax    FourthDimension.fieldName(fileno,fieldno)
  28. Action    Returns the name of the specified field.
  29. Parameters    fileno is the number of the file in your 4D database.
  30. fieldno is the number of the field.
  31. Returns    a string, the name of the specified field
  32. Examples    FourthDimension.fieldName(1,1)
  33.     » First Name
  34.  
  35. Verb    FourthDimension.currentRecord
  36. Syntax    FourthDimension.currentRecord(fileno)
  37. Action    Returns the current record number in the specified file
  38. Parameters    fileno is the number of the file in your 4D database.
  39. Returns    the current record number.
  40. Examples    FourthDimension.currentRecord(1)
  41.     » 3
  42. Notes    An error message will result if no records are selected or the current record hasn’t been set.
  43.  
  44. Verb    FourthDimension.recordsInSelection
  45. Syntax    FourthDimension.recordsInSelection(fileno)
  46. Action    Returns the number of records currently selected in the specified file.
  47. Parameters    fileno is the number of the file in your 4D database.
  48. Returns    An integer, the number of records currently selected.
  49. Examples    FourthDimension.recordsInSelection(1)
  50.     » 20
  51.  
  52. Verb    FourthDimension.fieldInfo
  53. Syntax    FourthDimension.fieldInfo(fileno,fieldno,tableAddr)
  54. Action    Inserts information about the specified field in a table. Entries titled ‘----’ which contains the name of the field, and ‘FTYP’ which contains a numeric code indicating the field type will be created (See 4D®'s Language Reference manual)
  55. Parameters    fileno is the number of the file in your 4D database.
  56. fieldno is the number of the field.
  57. tableAddr is the address of an existing table to receive the information.
  58. Returns    True
  59. Examples    FourthDimension.fieldInfo(1,2,@info)
  60.     » true
  61.  
  62. Verb    FourthDimension.getField
  63. Syntax    FourthDimension.getField(fileno,fieldno)
  64. Action    Returns the contents of the specified field in the current record.
  65. Parameters    fileno is the number of the file.
  66. fieldno is the number of the field.
  67. Returns    the contents of the field. Can be text or numeric, depending on how the field is defined in 4D.
  68. Examples    FourthDimension.getField(1,1)
  69.     » Mike
  70. Notes    An error will result if no current record has been set.
  71.  
  72. Verb    FourthDimension.doScript
  73. Syntax    FourthDimension.doScript(command)
  74. Action    Executes almost any 4D® command.
  75. Parameters    command is a string which should be a valid 4D command.
  76. Returns    True
  77. Examples    FourthDimension.doScript(“Alert(String(Current Time))”)
  78.     » True
  79. FourthDimension.doScript(“First Record([Names])”)
  80.     » True
  81.  
  82. Verb    FourthDimension.buildOutline
  83. Syntax    FourthDimension.buildOutline(where)
  84. Action    Builds an outline describing the database structure. A top-level heading will be created for each file and sub-headers will be created for each field in that file
  85. Parameters    ‘where’ is the address of an outline which will be created if necessary
  86. Returns    True
  87. Examples    FourthDimension.buildOutline(@scratchpad.x)
  88.     » True
  89.  
  90. Verb    FourthDimension.extractData
  91. Syntax    FourthDimension.extractData(fileno,where)
  92. Action    Builds an outline containing all data in the specified file.
  93. Parameters    fileno is the number of the file.
  94. ‘where’ is an outline to receive the data, which will be created if necessary.
  95. Returns    True
  96. Examples    FourthDimension.extractData(1,@scratchpad.x)
  97.     » True
  98.  
  99. Verb    FourthDimension.searchForData
  100. Syntax    FourthDimension.searchForData(fileno,expr,where)
  101. Action    Executes a simple search and builds an outline containing all records returned by the search.
  102. Parameters    fileno is the number of the file
  103. 'expr' is a valid 4th DIMENSION search expression. Field names must be qualified with the file name
  104. 'where' is an outline to receive the data, which will be created if necessary.
  105. Returns    True
  106. Examples    fourthDimension.searchForData(2,“[names]State="CA"”,@scratchPad.z)
  107.     » True
  108.